home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 4: GNU Archives / Linux Cubed Series 4 - GNU Archives.iso / gnu / cvs-1.8 / cvs-1 / cvs-1.8.1 / doc / cvs.info-4 < prev    next >
Encoding:
GNU Info File  |  1996-05-06  |  48.4 KB  |  1,448 lines
  1. This is Info file cvs.info, produced by Makeinfo-1.63 from the input
  2. file ./cvs.texinfo.
  3.  
  4.    Copyright (C) 1992, 1993 Signum Support AB Copyright (C) 1993, 1994
  5. Free Software Foundation, Inc.
  6.  
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10.  
  11.    Permission is granted to copy and distribute modified versions of
  12. this manual under the conditions for verbatim copying, provided also
  13. that the section entitled "GNU General Public License" is included
  14. exactly as in the original, and provided that the entire resulting
  15. derived work is distributed under the terms of a permission notice
  16. identical to this one.
  17.  
  18.    Permission is granted to copy and distribute translations of this
  19. manual into another language, under the above conditions for modified
  20. versions, except that the section entitled "GNU General Public License"
  21. and this permission notice may be included in translations approved by
  22. the Free Software Foundation instead of in the original English.
  23.  
  24. 
  25. File: cvs.info,  Node: commit,  Next: diff,  Prev: checkout,  Up: Invoking CVS
  26.  
  27. commit--Check files into the repository
  28. =======================================
  29.  
  30.    * Version 1.3 Synopsis: commit [-lnR] [-m 'log_message' | -f file]
  31.      [-r revision] [files...]
  32.  
  33.    * Version 1.3.1 Synopsis: commit [-lnRf] [-m 'log_message' | -F
  34.      file] [-r revision] [files...]
  35.  
  36.    * Requires: working directory, repository.
  37.  
  38.    * Changes: repository.
  39.  
  40.    * Synonym: ci
  41.  
  42.    *Warning:* The `-f FILE' option will probably be renamed to `-F
  43. FILE', and `-f' will be given a new behavior in future releases of CVS.
  44.  
  45.    Use `commit' when you want to incorporate changes from your working
  46. source files into the source repository.
  47.  
  48.    If you don't specify particular files to commit, all of the files in
  49. your working current directory are examined.  `commit' is careful to
  50. change in the repository only those files that you have really changed.
  51. By default (or if you explicitly specify the `-R' option), files in
  52. subdirectories are also examined and committed if they have changed;
  53. you can use the `-l' option to limit `commit' to the current directory
  54. only.
  55.  
  56.    `commit' verifies that the selected files are up to date with the
  57. current revisions in the source repository; it will notify you, and
  58. exit without committing, if any of the specified files must be made
  59. current first with `update' (*note update::.).  `commit' does not call
  60. the `update' command for you, but rather leaves that for you to do when
  61. the time is right.
  62.  
  63.    When all is well, an editor is invoked to allow you to enter a log
  64. message that will be written to one or more logging programs (*note
  65. modules::., and *note loginfo::.) and placed in the RCS history file
  66. inside the repository.  This log message can be retrieved with the
  67. `log' command; *Note log::.  You can specify the log message on the
  68. command line with the `-m MESSAGE' option, and thus avoid the editor
  69. invocation, or use the `-f FILE' option to specify that the argument
  70. file contains the log message.
  71.  
  72. * Menu:
  73.  
  74. * commit options::              commit options
  75. * commit examples::             commit examples
  76.  
  77. 
  78. File: cvs.info,  Node: commit options,  Next: commit examples,  Up: commit
  79.  
  80. commit options
  81. --------------
  82.  
  83.    These standard options are supported by `commit' (*note Common
  84. options::., for a complete description of them):
  85.  
  86. `-l'
  87.      Local; run only in current working directory.
  88.  
  89. `-n'
  90.      Do not run any module program.
  91.  
  92. `-R'
  93.      Commit directories recursively.  This is on by default.
  94.  
  95. `-r REVISION'
  96.      Commit to REVISION.  REVISION must be either a branch, or a
  97.      revision on the main trunk that is higher than any existing
  98.      revision number.  You cannot commit to a specific revision on a
  99.      branch.
  100.  
  101.    `commit' also supports these options:
  102.  
  103. `-F FILE'
  104.      This option is present in CVS releases 1.3-s3 and later.  Read the
  105.      log message from FILE, instead of invoking an editor.
  106.  
  107. `-f'
  108.      This option is present in CVS 1.3-s3 and later releases of CVS.
  109.      Note that this is not the standard behavior of the `-f' option as
  110.      defined in *Note Common options::.
  111.  
  112.      Force CVS to commit a new revision even if you haven't made any
  113.      changes to the file.  If the current revision of FILE is 1.7, then
  114.      the following two commands are equivalent:
  115.  
  116.           $ cvs commit -f FILE
  117.           $ cvs commit -r 1.8 FILE
  118.  
  119. `-f FILE'
  120.      This option is present in CVS releases 1.3, 1.3-s1 and 1.3-s2.
  121.      Note that this is not the standard behavior of the `-f' option as
  122.      defined in *Note Common options::.
  123.  
  124.      Read the log message from FILE, instead of invoking an editor.
  125.  
  126. `-m MESSAGE'
  127.      Use MESSAGE as the log message, instead of invoking an editor.
  128.  
  129. 
  130. File: cvs.info,  Node: commit examples,  Prev: commit options,  Up: commit
  131.  
  132. commit examples
  133. ---------------
  134.  
  135. New major release number
  136. ........................
  137.  
  138.    When you make a major release of your product, you might want the
  139. revision numbers to track your major release number.  You should
  140. normally not care about the revision numbers, but this is a thing that
  141. many people want to do, and it can be done without doing any harm.
  142.  
  143.    To bring all your files up to the RCS revision 3.0 (including those
  144. that haven't changed), you might do:
  145.  
  146.      $ cvs commit -r 3.0
  147.  
  148.    Note that it is generally a bad idea to try to make the RCS revision
  149. number equal to the current release number of your product.  You should
  150. think of the revision number as an internal number that the CVS package
  151. maintains, and that you generally never need to care much about.  Using
  152. the `tag' and `rtag' commands you can give symbolic names to the
  153. releases instead.  *Note tag:: and *Note rtag::.
  154.  
  155.    Note that the number you specify with `-r' must be larger than any
  156. existing revision number.  That is, if revision 3.0 exists, you cannot
  157. `cvs commit -r 1.3'.
  158.  
  159. Committing to a branch
  160. ......................
  161.  
  162.    You can commit to a branch revision (one that has an even number of
  163. dots) with the `-r' option.  To create a branch revision, use the `-b'
  164. option of the `rtag' or `tag' commands (*note tag::.  or *note
  165. rtag::.).  Then, either `checkout' or `update' can be used to base your
  166. sources on the newly created branch.  From that point on, all `commit'
  167. changes made within these working sources will be automatically added
  168. to a branch revision, thereby not disturbing main-line development in
  169. any way.  For example, if you had to create a patch to the 1.2 version
  170. of the product, even though the 2.0 version is already under
  171. development, you might do:
  172.  
  173.      $ cvs rtag -b -r FCS1_2 FCS1_2_Patch product_module
  174.      $ cvs checkout -r FCS1_2_Patch product_module
  175.      $ cd product_module
  176.      [[ hack away ]]
  177.      $ cvs commit
  178.  
  179. This works automatically since the `-r' option is sticky.
  180.  
  181. Creating the branch after editing
  182. .................................
  183.  
  184.    Say you have been working on some extremely experimental software,
  185. based on whatever revision you happened to checkout last week.  If
  186. others in your group would like to work on this software with you, but
  187. without disturbing main-line development, you could commit your change
  188. to a new branch.  Others can then checkout your experimental stuff and
  189. utilize the full benefit of CVS conflict resolution.  The scenario might
  190. look like:
  191.  
  192.      [[ hacked sources are present ]]
  193.      $ cvs tag -b EXPR1
  194.      $ cvs update -r EXPR1
  195.      $ cvs commit
  196.  
  197.    The `update' command will make the `-r EXPR1' option sticky on all
  198. files.  Note that your changes to the files will never be removed by the
  199. `update' command.  The `commit' will automatically commit to the
  200. correct branch, because the `-r' is sticky.  You could also do like
  201. this:
  202.  
  203.      [[ hacked sources are present ]]
  204.      $ cvs tag -b EXPR1
  205.      $ cvs commit -r EXPR1
  206.  
  207. but then, only those files that were changed by you will have the `-r
  208. EXPR1' sticky flag.  If you hack away, and commit without specifying
  209. the `-r EXPR1' flag, some files may accidentally end up on the main
  210. trunk.
  211.  
  212.    To work with you on the experimental change, others would simply do
  213.  
  214.      $ cvs checkout -r EXPR1 whatever_module
  215.  
  216. 
  217. File: cvs.info,  Node: diff,  Next: export,  Prev: commit,  Up: Invoking CVS
  218.  
  219. diff--Run diffs between revisions
  220. =================================
  221.  
  222.    * Synopsis: diff [-l] [rcsdiff_options] [[-r rev1 | -D date1] [-r
  223.      rev2 |  -D date2]] [files...]
  224.  
  225.    * Requires: working directory, repository.
  226.  
  227.    * Changes: nothing.
  228.  
  229.    The `diff' command is used to compare different revisions of files.
  230. The default action is to compare your working files with the revisions
  231. they were based on, and report any differences that are found.
  232.  
  233.    If any file names are given, only those files are compared.  If any
  234. directories are given, all files under them will be compared.
  235.  
  236.    The exit status will be 0 if no differences were found, 1 if some
  237. differences were found, and 2 if any error occurred.
  238.  
  239. * Menu:
  240.  
  241. * diff options::                diff options
  242. * diff examples::               diff examples
  243.  
  244. 
  245. File: cvs.info,  Node: diff options,  Next: diff examples,  Up: diff
  246.  
  247. diff options
  248. ------------
  249.  
  250.    These standard options are supported by `diff' (*note Common
  251. options::., for a complete description of them):
  252.  
  253. `-D DATE'
  254.      Use the most recent revision no later than DATE.  See `-r' for how
  255.      this affects the comparison.
  256.  
  257.      CVS can be configured to pass the `-D' option through to `rcsdiff'
  258.      (which in turn passes it on to `diff'.  GNU diff uses `-D' as a
  259.      way to put `cpp'-style `#define' statements around the output
  260.      differences.  There is no way short of testing to figure out how
  261.      CVS was configured.  In the default configuration CVS will use the
  262.      `-D DATE' option.
  263.  
  264. `-k KFLAG'
  265.      Process RCS keywords according to KFLAG.  See co(1).
  266.  
  267. `-l'
  268.      Local; run only in current working directory.
  269.  
  270. `-R'
  271.      Examine directories recursively.  This option is on by default.
  272.  
  273. `-r TAG'
  274.      Compare with revision TAG.  Zero, one or two `-r' options can be
  275.      present.  With no `-r' option, the working file will be compared
  276.      with the revision it was based on.  With one `-r', that revision
  277.      will be compared to your current working file.  With two `-r'
  278.      options those two revisions will be compared (and your working
  279.      file will not affect the outcome in any way).
  280.  
  281.      One or both `-r' options can be replaced by a `-D DATE' option,
  282.      described above.
  283.  
  284.    Any other options that are found are passed through to `rcsdiff',
  285. which in turn passes them to `diff'.  The exact meaning of the options
  286. depends on which `diff' you are using.  The long options introduced in
  287. GNU diff 2.0 are not yet supported in CVS.  See the documentation for
  288. your `diff' to see which options are supported.
  289.  
  290. 
  291. File: cvs.info,  Node: diff examples,  Prev: diff options,  Up: diff
  292.  
  293. diff examples
  294. -------------
  295.  
  296.    The following line produces a Unidiff (`-u' flag) between revision
  297. 1.14 and 1.19 of `backend.c'.  Due to the `-kk' flag no keywords are
  298. substituted, so differences that only depend on keyword substitution
  299. are ignored.
  300.  
  301.      $ cvs diff -kk -u -r 1.14 -r 1.19 backend.c
  302.  
  303.    Suppose the experimental branch EXPR1 was based on a set of files
  304. tagged RELEASE_1_0.  To see what has happened on that branch, the
  305. following can be used:
  306.  
  307.      $ cvs diff -r RELEASE_1_0 -r EXPR1
  308.  
  309.    A command like this can be used to produce a context diff between
  310. two releases:
  311.  
  312.      $ cvs diff -c -r RELEASE_1_0 -r RELEASE_1_1 > diffs
  313.  
  314.    If you are maintaining ChangeLogs, a command like the following just
  315. before you commit your changes may help you write the ChangeLog entry.
  316. All local modifications that have not yet been committed will be
  317. printed.
  318.  
  319.      $ cvs diff -u | less
  320.  
  321. 
  322. File: cvs.info,  Node: export,  Next: history,  Prev: diff,  Up: Invoking CVS
  323.  
  324. export--Export sources from CVS, similar to checkout
  325. ====================================================
  326.  
  327.    * Synopsis: export [-flNn] [-r rev|-D date] [-k subst] [-d dir]
  328.      module...
  329.  
  330.    * Requires: repository.
  331.  
  332.    * Changes: current directory.
  333.  
  334.    This command is a variant of `checkout'; use it when you want a copy
  335. of the source for module without the CVS administrative directories.
  336. For example, you might use `export' to prepare source for shipment
  337. off-site.  This command requires that you specify a date or tag (with
  338. `-D' or `-r'), so that you can count on reproducing the source you ship
  339. to others.
  340.  
  341.    One often would like to use `-kv' with `cvs export'.  This causes
  342. any RCS keywords to be expanded such that an import done at some other
  343. site will not lose the keyword revision information.  But be aware that
  344. doesn't handle an export containing binary files correctly.  Also be
  345. aware that after having used `-kv', one can no longer use the `ident'
  346. command (which is part of the RCS suite--see ident(1)) which looks for
  347. RCS keyword strings.  If you want to be able to use `ident' you must not
  348. use `-kv'.
  349.  
  350. * Menu:
  351.  
  352. * export options::              export options
  353.  
  354. 
  355. File: cvs.info,  Node: export options,  Up: export
  356.  
  357. export options
  358. --------------
  359.  
  360.    These standard options are supported by `export' (*note Common
  361. options::., for a complete description of them):
  362.  
  363. `-D DATE'
  364.      Use the most recent revision no later than DATE.
  365.  
  366. `-f'
  367.      If no matching revision is found, retrieve the most recent
  368.      revision (instead of ignoring the file).
  369.  
  370. `-l'
  371.      Local; run only in current working directory.
  372.  
  373. `-n'
  374.      Do not run any checkout program.
  375.  
  376. `-R'
  377.      Export directories recursively.  This is on by default.
  378.  
  379. `-r TAG'
  380.      Use revision TAG.
  381.  
  382.    In addition, these options (that are common to `checkout' and
  383. `export') are also supported:
  384.  
  385. `-d DIR'
  386.      Create a directory called DIR for the working files, instead of
  387.      using the module name.  Unless you also use `-N', the paths
  388.      created under DIR will be as short as possible.
  389.  
  390. `-k SUBST'
  391.      Set keyword expansion mode (*note Substitution modes::.).
  392.  
  393. `-N'
  394.      Only useful together with `-d DIR'.  With this option, CVS will
  395.      not shorten module paths in your working directory.  (Normally,
  396.      CVS shortens paths as much as possible when you specify an
  397.      explicit target directory.)
  398.  
  399. 
  400. File: cvs.info,  Node: history,  Next: import,  Prev: export,  Up: Invoking CVS
  401.  
  402. history--Show status of files and users
  403. =======================================
  404.  
  405.    * Synopsis:     history [-report] [-flags] [-options args] [files...]
  406.  
  407.    * Requires: the file `$CVSROOT/CVSROOT/history'
  408.  
  409.    * Changes: nothing.
  410.  
  411.    CVS can keep a history file that tracks each use of the `checkout',
  412. `commit', `rtag', `update', and `release' commands.  You can use
  413. `history' to display this information in various formats.
  414.  
  415.    Logging must be enabled by creating the file
  416. `$CVSROOT/CVSROOT/history'.
  417.  
  418.    *Warning:* `history' uses `-f', `-l', `-n', and `-p' in ways that
  419. conflict with the normal use inside CVS (*note Common options::.).
  420.  
  421. * Menu:
  422.  
  423. * history options::             history options
  424.  
  425. 
  426. File: cvs.info,  Node: history options,  Up: history
  427.  
  428. history options
  429. ---------------
  430.  
  431.    Several options (shown above as `-report')  control  what kind of
  432. report is generated:
  433.  
  434. `-c'
  435.      Report on each time commit was used (i.e., each time the
  436.      repository was modified).
  437.  
  438. `-e'
  439.      Everything (all record types); equivalent to specifying
  440.      `-xMACFROGWUT'.
  441.  
  442. `-m MODULE'
  443.      Report on a particular module.  (You can meaningfully use `-m'
  444.      more than once on the command line.)
  445.  
  446. `-o'
  447.      Report on checked-out modules.
  448.  
  449. `-T'
  450.      Report on all tags.
  451.  
  452. `-x TYPE'
  453.      Extract a particular set of record types TYPE from the CVS
  454.      history.  The types are indicated by single letters, which you may
  455.      specify in combination.
  456.  
  457.      Certain commands have a single record type:
  458.  
  459.     `F'
  460.           release
  461.  
  462.     `O'
  463.           checkout
  464.  
  465.     `T'
  466.           rtag
  467.  
  468.      One of four record types may result from an update:
  469.  
  470.     `C'
  471.           A merge was necessary but collisions were detected (requiring
  472.           manual merging).
  473.  
  474.     `G'
  475.           A merge was necessary and it succeeded.
  476.  
  477.     `U'
  478.           A working file was copied from the repository.
  479.  
  480.     `W'
  481.           The working copy of a file was deleted during update (because
  482.           it was gone from the repository).
  483.  
  484.      One of three record types results from commit:
  485.  
  486.     `A'
  487.           A file was added for the first time.
  488.  
  489.     `M'
  490.           A file was modified.
  491.  
  492.     `R'
  493.           A file was removed.
  494.  
  495.    The options shown as `-flags' constrain or expand the report without
  496. requiring option arguments:
  497.  
  498. `-a'
  499.      Show data for all users (the default is to show data only for the
  500.      user executing `history').
  501.  
  502. `-l'
  503.      Show last modification only.
  504.  
  505. `-w'
  506.      Show only the records for modifications done from the same working
  507.      directory where `history' is executing.
  508.  
  509.    The options shown as `-options ARGS' constrain the report based on
  510. an argument:
  511.  
  512. `-b STR'
  513.      Show data back to a record containing  the  string STR  in  either
  514.      the module name, the file name, or the repository path.
  515.  
  516. `-D DATE'
  517.      Show data since DATE.  This is slightly different from the normal
  518.      use of `-D DATE', which selects the newest revision older than
  519.      DATE.
  520.  
  521. `-p REPOSITORY'
  522.      Show data for a particular source repository  (you can specify
  523.      several `-p' options on the same command line).
  524.  
  525. `-r REV'
  526.      Show records referring to revisions since the revision or tag
  527.      named REV appears in individual RCS files.  Each RCS file is
  528.      searched for the revision or tag.
  529.  
  530. `-t TAG'
  531.      Show records since tag TAG was last added to the the history file.
  532.      This differs from the `-r' flag above in that it reads only the
  533.      history file, not the RCS files, and is much faster.
  534.  
  535. `-u NAME'
  536.      Show records for user NAME.
  537.  
  538. 
  539. File: cvs.info,  Node: import,  Next: log,  Prev: history,  Up: Invoking CVS
  540.  
  541. import--Import sources into CVS, using vendor branches
  542. ======================================================
  543.  
  544.    * Synopsis: import [-options] repository vendortag releasetag...
  545.  
  546.    * Requires: Repository, source distribution directory.
  547.  
  548.    * Changes: repository.
  549.  
  550.    Use `import' to incorporate an entire source distribution from an
  551. outside source (e.g., a source vendor) into your source repository
  552. directory.  You can use this command both for initial creation of a
  553. repository, and for wholesale updates to the module from the outside
  554. source.  *Note Tracking sources::, for a discussion on this subject.
  555.  
  556.    The REPOSITORY argument gives a directory name (or a path to a
  557. directory) under the CVS root directory for repositories; if the
  558. directory did not exist, import creates it.
  559.  
  560.    When you use import for updates to source that has been modified in
  561. your source repository (since a prior import), it will notify you of
  562. any files that conflict in the two branches of development; use
  563. `checkout -j' to reconcile the differences, as import instructs you to
  564. do.
  565.  
  566.    If CVS decides a file should be ignored (*note cvsignore::.), it
  567. does not import it and prints `I ' followed by the filename
  568.  
  569.    If the file `$CVSROOT/CVSROOT/cvswrappers' exists, any file whose
  570. names match the specifications in that file will be treated as packages
  571. and the appropriate filtering will be performed on the file/directory
  572. before being imported, *Note Wrappers::.
  573.  
  574.    The outside source is saved in a first-level RCS branch, by default
  575. 1.1.1.  Updates are leaves of this branch; for example, files from the
  576. first imported collection of source will be revision 1.1.1.1, then
  577. files from the first imported update will be revision 1.1.1.2, and so
  578. on.
  579.  
  580.    At least three arguments are required.  REPOSITORY is needed to
  581. identify the collection of source.  VENDORTAG is a tag for the entire
  582. branch (e.g., for 1.1.1).  You must also specify at least one
  583. RELEASETAG to identify the files at the leaves created each time you
  584. execute `import'.
  585.  
  586. * Menu:
  587.  
  588. * import options::              import options
  589. * import examples::             import examples
  590.  
  591. 
  592. File: cvs.info,  Node: import options,  Next: import examples,  Up: import
  593.  
  594. import options
  595. --------------
  596.  
  597.    This standard option is supported by `import' (*note Common
  598. options::., for a complete description):
  599.  
  600. `-m MESSAGE'
  601.      Use MESSAGE as log information, instead of invoking an editor.
  602.  
  603.    There are three additional special options.
  604.  
  605. `-b BRANCH'
  606.      Specify a first-level branch other than 1.1.1.  Unless the `-b
  607.      BRANCH' flag is given, revisions will *always* be made to the
  608.      branch 1.1.1--even if a VENDORTAG that matches another branch is
  609.      given!  What happens in that case, is that the tag will be reset
  610.      to 1.1.1.  Warning: This behavior might change in the future.
  611.  
  612. `-k SUBST'
  613.      Indicate the RCS keyword expansion mode desired.  This setting
  614.      will apply to all files created during the import, but not to any
  615.      files that previously existed in the repository.  See *Note
  616.      Substitution modes:: for a list of valid `-k' settings.
  617.  
  618. `-I NAME'
  619.      Specify file names that should be ignored during import.  You can
  620.      use this option repeatedly.  To avoid ignoring any files at all
  621.      (even those ignored by default), specify `-I !'.
  622.  
  623.      NAME can be a file name pattern of the same type that you can
  624.      specify in the `.cvsignore' file.  *Note cvsignore::.
  625.  
  626. `-W SPEC'
  627.      Specify file names that should be filtered during import.  You can
  628.      use this option repeatedly.
  629.  
  630.      SPEC can be a file name pattern of the same type that you can
  631.      specify in the `.cvswrappers' file. *Note Wrappers::.
  632.  
  633. 
  634. File: cvs.info,  Node: import examples,  Prev: import options,  Up: import
  635.  
  636. import examples
  637. ---------------
  638.  
  639.    *Note Tracking sources::, and *Note From files::.
  640.  
  641. 
  642. File: cvs.info,  Node: log,  Next: rdiff,  Prev: import,  Up: Invoking CVS
  643.  
  644. log--Print out 'rlog' information for files
  645. ===========================================
  646.  
  647.    * Synopsis: log [-l] rlog-options [files...]
  648.  
  649.    * Requires: repository, working directory.
  650.  
  651.    * Changes: nothing.
  652.  
  653.    * Synonym: rlog
  654.  
  655.    Display log information for files.  `log' calls the RCS utility
  656. `rlog', which prints all available information about the RCS history
  657. file.  This includes the location of the RCS file, the "head" revision
  658. (the latest revision on the trunk), all symbolic names (tags) and some
  659. other things.  For each revision, the revision number, the author, the
  660. number of lines added/deleted and the log message are printed.  All
  661. times are displayed in Coordinated Universal Time (UTC).  (Other parts
  662. of CVS print times in the local timezone).
  663.  
  664. * Menu:
  665.  
  666. * log options::                 log options
  667. * log examples::                log examples
  668.  
  669. 
  670. File: cvs.info,  Node: log options,  Next: log examples,  Up: log
  671.  
  672. log options
  673. -----------
  674.  
  675.    Only one option is interpreted by CVS and not passed on to `rlog':
  676.  
  677. `-l'
  678.      Local; run only in current working directory.  (Default is to run
  679.      recursively).
  680.  
  681.    By default, `rlog' prints all information that is available.  All
  682. other options (including those that normally behave differently) are
  683. passed through to `rlog' and restrict the output.  See rlog(1) for a
  684. complete description of options.  This incomplete list (which is a
  685. slightly edited extract from rlog(1)) lists all options that are useful
  686. in conjunction with CVS.
  687.  
  688.    *Please note:*  There can be no space between the option and its
  689. argument, since `rlog' parses its options in a different way than CVS.
  690.  
  691. `-b'
  692.      Print information about the revisions on the default branch,
  693.      normally the highest branch on the trunk.
  694.  
  695. `-dDATES'
  696.      Print information about revisions with a checkin date/time in the
  697.      range given by the semicolon-separated list of dates.  The
  698.      following table explains the available range formats:
  699.  
  700.     `D1<D2'
  701.     `D2>D1'
  702.           Select the revisions that were deposited between D1 and D2
  703.           inclusive.
  704.  
  705.     `<D'
  706.     `D>'
  707.           Select all revisions dated D or earlier.
  708.  
  709.     `D<'
  710.     `>D'
  711.           Select all revisions dated D or later.
  712.  
  713.     `D'
  714.           Select the single, latest revision dated D or earlier.
  715.  
  716.      The date/time strings D, D1, and D2 are in the free format
  717.      explained in co(1).  Quoting is normally necessary, especially for
  718.      < and >.  Note that the separator is a semicolon (;).
  719.  
  720. `-h'
  721.      Print only the RCS pathname, working pathname, head, default
  722.      branch, access list, locks, symbolic names, and suffix.
  723.  
  724. `-N'
  725.      Do not print the list of tags for this file.  This option can be
  726.      very useful when your site uses a lot of tags, so rather than
  727.      "more"'ing over 3 pages of tag information, the log information is
  728.      presented without tags at all.
  729.  
  730. `-R'
  731.      Print only the name of the RCS history file.
  732.  
  733. `-rREVISIONS'
  734.      Print information about revisions given in the comma-separated
  735.      list REVISIONS of revisions and ranges.  The following table
  736.      explains the available range formats:
  737.  
  738.     `REV1:REV2'
  739.           Revisions REV1 to REV2 (which must be on the same branch).
  740.  
  741.     `:REV'
  742.           Revisions from the beginning of the branch up to and
  743.           including REV.
  744.  
  745.     `REV:'
  746.           Revisions starting with REV to the end of the branch
  747.           containing REV.
  748.  
  749.     `BRANCH'
  750.           An argument that is a branch means all revisions on that
  751.           branch.  You can unfortunately not specify a symbolic branch
  752.           here.  You must specify the numeric branch number.  *Note
  753.           Magic branch numbers::, for an explanation.
  754.  
  755.     `BRANCH1:BRANCH2'
  756.           A range of branches means all revisions on the branches in
  757.           that range.
  758.  
  759.     `BRANCH.'
  760.           The latest revision in BRANCH.
  761.  
  762.      A bare `-r' with no revisions means the latest revision on the
  763.      default branch, normally the trunk.
  764.  
  765. `-sSTATES'
  766.      Print information about revisions whose state attributes match one
  767.      of the states given in the comma-separated list STATES.
  768.  
  769. `-t'
  770.      Print the same as `-h', plus the descriptive text.
  771.  
  772. `-wLOGINS'
  773.      Print information about revisions checked in by users with login
  774.      names appearing in the comma-separated list LOGINS.  If LOGINS is
  775.      omitted, the user's login is assumed.
  776.  
  777.    `rlog' prints the intersection of the revisions selected with the
  778. options `-d', `-l', `-s', and `-w', intersected with the union of the
  779. revisions selected by `-b' and `-r'.
  780.  
  781. 
  782. File: cvs.info,  Node: log examples,  Prev: log options,  Up: log
  783.  
  784. log examples
  785. ------------
  786.  
  787.    Contributed examples are gratefully accepted.
  788.  
  789. 
  790. File: cvs.info,  Node: rdiff,  Next: release,  Prev: log,  Up: Invoking CVS
  791.  
  792. rdiff--'patch' format diffs between releases
  793. ============================================
  794.  
  795.    * rdiff [-flags] [-V vn] [-r t|-D d [-r t2|-D d2]] modules...
  796.  
  797.    * Requires: repository.
  798.  
  799.    * Changes: nothing.
  800.  
  801.    * Synonym: patch
  802.  
  803.    Builds a Larry Wall format patch(1) file between two releases, that
  804. can be fed directly into the patch program to bring an old release
  805. up-to-date with the new release.  (This is one of the few CVS commands
  806. that operates directly from the repository, and doesn't require a prior
  807. checkout.) The diff output is sent to the standard output device.
  808.  
  809.    You can specify (using the standard `-r' and `-D' options) any
  810. combination of one or two revisions or dates.  If only one revision or
  811. date is specified, the patch file reflects differences between that
  812. revision or date and the current head revisions in the RCS file.
  813.  
  814.    Note that if the software release affected is contained in more than
  815. one directory, then it may be necessary to specify the `-p' option to
  816. the patch command when patching the old sources, so that patch is able
  817. to find the files that are located in other directories.
  818.  
  819. * Menu:
  820.  
  821. * rdiff options::               rdiff options
  822. * rdiff examples::              rdiff examples
  823.  
  824. 
  825. File: cvs.info,  Node: rdiff options,  Next: rdiff examples,  Up: rdiff
  826.  
  827. rdiff options
  828. -------------
  829.  
  830.    These standard options are supported by `rdiff' (*note Common
  831. options::., for a complete description of them):
  832.  
  833. `-D DATE'
  834.      Use the most recent revision no later than DATE.
  835.  
  836. `-f'
  837.      If no matching revision is found, retrieve the most recent
  838.      revision (instead of ignoring the file).
  839.  
  840. `-l'
  841.      Local; don't descend subdirectories.
  842.  
  843. `-r TAG'
  844.      Use revision TAG.
  845.  
  846.    In addition to the above, these options are available:
  847.  
  848. `-c'
  849.      Use the context diff format.  This is the default format.
  850.  
  851. `-s'
  852.      Create a summary change report instead of a patch.  The summary
  853.      includes information about files that were changed or added
  854.      between the releases.  It is sent to the standard output device.
  855.      This is useful for finding out, for example, which files have
  856.      changed between two dates or revisions.
  857.  
  858. `-t'
  859.      A diff of the top two revisions is sent to the standard output
  860.      device.  This is most useful for seeing what the last change to a
  861.      file was.
  862.  
  863. `-u'
  864.      Use the unidiff format for the context diffs.  This option is not
  865.      available if your diff does not support the unidiff format.
  866.      Remember that old versions of the `patch' program can't handle the
  867.      unidiff format, so if you plan to post this patch to the net you
  868.      should probably not use `-u'.
  869.  
  870. `-V VN'
  871.      Expand RCS keywords according to the rules current in RCS version
  872.      VN (the expansion format changed with RCS version 5).
  873.  
  874. 
  875. File: cvs.info,  Node: rdiff examples,  Prev: rdiff options,  Up: rdiff
  876.  
  877. rdiff examples
  878. --------------
  879.  
  880.    Suppose you receive mail from foo@bar.com asking for an update from
  881. release 1.2 to 1.4 of the tc compiler.  You have no such patches on
  882. hand, but with CVS that can easily be fixed with a command such as this:
  883.  
  884.      $ cvs rdiff -c -r FOO1_2 -r FOO1_4 tc | \
  885.      $$ Mail -s 'The patches you asked for' foo@bar.com
  886.  
  887.    Suppose you have made release 1.3, and forked a branch called
  888. `R_1_3fix' for bugfixes.  `R_1_3_1' corresponds to release 1.3.1, which
  889. was made some time ago.  Now, you want to see how much development has
  890. been done on the branch.  This command can be used:
  891.  
  892.      $ cvs patch -s -r R_1_3_1 -r R_1_3fix module-name
  893.      cvs rdiff: Diffing module-name
  894.      File ChangeLog,v changed from revision 1.52.2.5 to 1.52.2.6
  895.      File foo.c,v changed from revision 1.52.2.3 to 1.52.2.4
  896.      File bar.h,v changed from revision 1.29.2.1 to 1.2
  897.  
  898. 
  899. File: cvs.info,  Node: release,  Next: rtag,  Prev: rdiff,  Up: Invoking CVS
  900.  
  901. release--Indicate that a Module is no longer in use
  902. ===================================================
  903.  
  904.    * release [-d] directories...
  905.  
  906.    * Requires: Working directory.
  907.  
  908.    * Changes: Working directory, history log.
  909.  
  910.    This command is meant to safely cancel the effect of `cvs checkout'.
  911. Since CVS doesn't lock files, it isn't strictly necessary to use this
  912. command.  You can always simply delete your working directory, if you
  913. like; but you risk losing changes you may have forgotten, and you leave
  914. no trace in the CVS history file (*note history file::.) that you've
  915. abandoned your checkout.
  916.  
  917.    Use `cvs release' to avoid these problems.  This command checks that
  918. no uncommitted changes are present; that you are executing it from
  919. immediately above a CVS working directory; and that the repository
  920. recorded for your files is the same as the repository defined in the
  921. module database.
  922.  
  923.    If all these conditions are true, `cvs release' leaves a record of
  924. its execution (attesting to your intentionally abandoning your
  925. checkout) in the CVS history log.
  926.  
  927. * Menu:
  928.  
  929. * release options::             release options
  930. * release output::              release options
  931. * release examples::            release examples
  932.  
  933. 
  934. File: cvs.info,  Node: release options,  Next: release output,  Up: release
  935.  
  936. release options
  937. ---------------
  938.  
  939.    The `release' command supports one command option:
  940.  
  941. `-d'
  942.      Delete your working copy of the file if the release succeeds.  If
  943.      this flag is not given your files will remain in your working
  944.      directory.
  945.  
  946.      *Warning:*  The `release' command uses `rm -r `module'' to delete
  947.      your file.  This has the very serious side-effect that any
  948.      directory that you have created inside your checked-out sources,
  949.      and not added to the repository (using the `add' command; *note
  950.      add::.) will be silently deleted--even if it is non-empty!
  951.  
  952. 
  953. File: cvs.info,  Node: release output,  Next: release examples,  Prev: release options,  Up: release
  954.  
  955. release output
  956. --------------
  957.  
  958.    Before `release' releases your sources it will print a one-line
  959. message for any file that is not up-to-date.
  960.  
  961.    *Warning:*  Any new directories that you have created, but not added
  962. to the CVS directory hierarchy with the `add' command (*note add::.)
  963. will be silently ignored (and deleted, if `-d' is specified), even if
  964. they contain files.
  965.  
  966. `U FILE'
  967.      There exists a newer revision of this file in the repository, and
  968.      you have not modified your local copy of the file.
  969.  
  970. `A FILE'
  971.      The file has been added to your private copy of the sources, but
  972.      has not yet been committed to the repository.  If you delete your
  973.      copy of the sources this file will be lost.
  974.  
  975. `R FILE'
  976.      The file has been removed from your private copy of the sources,
  977.      but has not yet been removed from the repository, since you have
  978.      not yet committed the removal.  *Note commit::.
  979.  
  980. `M FILE'
  981.      The file is modified in your working directory.  There might also
  982.      be a newer revision inside the repository.
  983.  
  984. `? FILE'
  985.      FILE is in your working directory, but does not correspond to
  986.      anything in the source repository, and is not in the list of files
  987.      for CVS to ignore (see the description of the `-I' option, and
  988.      *note cvsignore::.).  If you remove your working sources, this
  989.      file will be lost.
  990.  
  991.      Note that no warning message like this is printed for spurious
  992.      directories that CVS encounters.  The directory, and all its
  993.      contents, are silently ignored.
  994.  
  995. 
  996. File: cvs.info,  Node: release examples,  Prev: release output,  Up: release
  997.  
  998. release examples
  999. ----------------
  1000.  
  1001.    Release the module, and delete your local working copy of the files.
  1002.  
  1003.      $ cd ..         # You must stand immediately above the
  1004.                      # sources when you issue `cvs release'.
  1005.      $ cvs release -d tc
  1006.      You have [0] altered files in this repository.
  1007.      Are you sure you want to release (and delete) module `tc': y
  1008.      $
  1009.  
  1010. 
  1011. File: cvs.info,  Node: rtag,  Next: status,  Prev: release,  Up: Invoking CVS
  1012.  
  1013. rtag--Add a tag to the RCS file
  1014. ===============================
  1015.  
  1016.    * rtag [-falnR] [-b] [-d] [-r tag | -Ddate] symbolic_tag modules...
  1017.  
  1018.    * Requires: repository.
  1019.  
  1020.    * Changes: repository.
  1021.  
  1022.    * Synonym: rfreeze
  1023.  
  1024.    You can use this command to assign symbolic tags to particular,
  1025. explicitly specified source revisions in the repository.  `rtag' works
  1026. directly on the repository contents (and requires no prior checkout).
  1027. Use `tag' instead (*note tag::.), to base the selection of revisions on
  1028. the contents of your working directory.
  1029.  
  1030.    If you attempt to use a tag name that already exists, CVS will
  1031. complain and not overwrite that tag.  Use the `-F' option to force the
  1032. new tag value.
  1033.  
  1034. * Menu:
  1035.  
  1036. * rtag options::                rtag options
  1037.  
  1038. 
  1039. File: cvs.info,  Node: rtag options,  Up: rtag
  1040.  
  1041. rtag options
  1042. ------------
  1043.  
  1044.    These standard options are supported by `rtag' (*note Common
  1045. options::., for a complete description of them):
  1046.  
  1047. `-D DATE'
  1048.      Tag the most recent revision no later than DATE.
  1049.  
  1050. `-f'
  1051.      Only useful with the `-D DATE' or `-r TAG' flags.  If no matching
  1052.      revision is found, use the most recent revision (instead of
  1053.      ignoring the file).
  1054.  
  1055. `-F'
  1056.      Overwrite an existing tag of the same name on a different
  1057.      revision.  This option is new in CVS 1.4.  The old behavior is
  1058.      matched by `cvs tag -F'.
  1059.  
  1060. `-l'
  1061.      Local; run only in current working directory.
  1062.  
  1063. `-n'
  1064.      Do not run any tag program that was specified with the `-t' flag
  1065.      inside the `modules' file.  (*note modules::.).
  1066.  
  1067. `-R'
  1068.      Commit directories recursively.  This is on by default.
  1069.  
  1070. `-r TAG'
  1071.      Only tag those files that contain TAG.  This can be used to rename
  1072.      a tag: tag only the files identified by the old tag, then delete
  1073.      the old tag, leaving the new tag on exactly the same files as the
  1074.      old tag.
  1075.  
  1076.    In addition to the above common options, these options are available:
  1077.  
  1078. `-a'
  1079.      Use the `-a' option to have `rtag' look in the `Attic' (*note
  1080.      Removing files::.) for removed files that contain the specified
  1081.      tag.  The tag is removed from these files, which makes it
  1082.      convenient to re-use a symbolic tag as development continues (and
  1083.      files get removed from the up-coming distribution).
  1084.  
  1085. `-b'
  1086.      Make the tag a branch tag.  *Note Branches::.
  1087.  
  1088. `-d'
  1089.      Delete the tag instead of creating it.
  1090.  
  1091.      In general, tags (often the symbolic names of software
  1092.      distributions) should not be removed, but the `-d' option is
  1093.      available as a means to remove completely obsolete symbolic names
  1094.      if necessary (as might be the case for an Alpha release, or if you
  1095.      mistagged a module).
  1096.  
  1097. 
  1098. File: cvs.info,  Node: status,  Next: tag,  Prev: rtag,  Up: Invoking CVS
  1099.  
  1100. status--Status info on the revisions
  1101. ====================================
  1102.  
  1103.    * status [-lR] [-v] [files...]
  1104.  
  1105.    * Requires: working directory, repository.
  1106.  
  1107.    * Changes: nothing.
  1108.  
  1109.    Display a brief report on the current status of files with respect
  1110. to the source repository, including any sticky tags, dates, or `-k'
  1111. options.
  1112.  
  1113.    You can also use this command to determine the potential impact of a
  1114. `cvs update' on your working source directory--but remember that things
  1115. might change in the repository before you run `update'.
  1116.  
  1117. * Menu:
  1118.  
  1119. * status options::              status options
  1120.  
  1121. 
  1122. File: cvs.info,  Node: status options,  Up: status
  1123.  
  1124. status options
  1125. --------------
  1126.  
  1127.    These standard options are supported by `status' (*note Common
  1128. options::., for a complete description of them):
  1129.  
  1130. `-l'
  1131.      Local; run only in current working directory.
  1132.  
  1133. `-R'
  1134.      Commit directories recursively.  This is on by default.
  1135.  
  1136.    There is one additional option:
  1137.  
  1138. `-v'
  1139.      Verbose.  In addition to the information normally displayed, print
  1140.      all symbolic tags, together with the numerical value of the
  1141.      revision or branch they refer to.
  1142.  
  1143. 
  1144. File: cvs.info,  Node: tag,  Next: update,  Prev: status,  Up: Invoking CVS
  1145.  
  1146. tag--Add a symbolic tag to checked out version of RCS file
  1147. ==========================================================
  1148.  
  1149.    * tag [-lR] [-b] [-d] symbolic_tag [files...]
  1150.  
  1151.    * Requires: working directory, repository.
  1152.  
  1153.    * Changes: repository.
  1154.  
  1155.    * Synonym: freeze
  1156.  
  1157.    Use this command to assign symbolic tags to the nearest repository
  1158. versions to your working sources.  The tags are applied immediately to
  1159. the repository, as with `rtag', but the versions are supplied
  1160. implicitly by the CVS records of your working files' history rather than
  1161. applied explicitly.
  1162.  
  1163.    One use for tags is to record a snapshot of the current sources when
  1164. the software freeze date of a project arrives.  As bugs are fixed after
  1165. the freeze date, only those changed sources that are to be part of the
  1166. release need be re-tagged.
  1167.  
  1168.    The symbolic tags are meant to permanently record which revisions of
  1169. which files were used in creating a software distribution.  The
  1170. `checkout' and `update' commands allow you to extract an exact copy of
  1171. a tagged release at any time in the future, regardless of whether files
  1172. have been changed, added, or removed since the release was tagged.
  1173.  
  1174.    This command can also be used to delete a symbolic tag, or to create
  1175. a branch.  See the options section below.
  1176.  
  1177.    If you attempt to use a tag name that already exists, CVS will
  1178. complain and not overwrite that tag.  Use the `-F' option to force the
  1179. new tag value.
  1180.  
  1181. * Menu:
  1182.  
  1183. * tag options::                 tag options
  1184.  
  1185. 
  1186. File: cvs.info,  Node: tag options,  Up: tag
  1187.  
  1188. tag options
  1189. -----------
  1190.  
  1191.    These standard options are supported by `tag' (*note Common
  1192. options::., for a complete description of them):
  1193.  
  1194. `-F'
  1195.      Overwrite an existing tag of the same name on a different
  1196.      revision.  This option is new in CVS 1.4.  The old behavior is
  1197.      matched by `cvs tag -F'.
  1198.  
  1199. `-l'
  1200.      Local; run only in current working directory.
  1201.  
  1202. `-R'
  1203.      Commit directories recursively.  This is on by default.
  1204.  
  1205.    Two special options are available:
  1206.  
  1207. `-b'
  1208.      The -b option makes the tag a branch tag (*note Branches::.),
  1209.      allowing concurrent, isolated development.  This is most useful
  1210.      for creating a patch to a previously released software
  1211.      distribution.
  1212.  
  1213. `-d'
  1214.      Delete a tag.
  1215.  
  1216.      If you use `cvs tag -d symbolic_tag', the symbolic tag you specify
  1217.      is deleted instead of being added.  Warning: Be very certain of
  1218.      your ground before you delete a tag; doing this permanently
  1219.      discards some historical information, which may later turn out to
  1220.      be valuable.
  1221.  
  1222. 
  1223. File: cvs.info,  Node: update,  Prev: tag,  Up: Invoking CVS
  1224.  
  1225. update--Bring work tree in sync with repository
  1226. ===============================================
  1227.  
  1228.    * update [-AdflPpR] [-d] [-r tag|-D date] files...
  1229.  
  1230.    * Requires: repository, working directory.
  1231.  
  1232.    * Changes: working directory.
  1233.  
  1234.    After you've run checkout to create your private copy of source from
  1235. the common repository, other developers will continue changing the
  1236. central source.  From time to time, when it is convenient in your
  1237. development process, you can use the `update' command from within your
  1238. working directory to reconcile your work with any revisions applied to
  1239. the source repository since your last checkout or update.
  1240.  
  1241. * Menu:
  1242.  
  1243. * update options::              update options
  1244. * update output::               update output
  1245. * update examples::             update examples
  1246.  
  1247. 
  1248. File: cvs.info,  Node: update options,  Next: update output,  Up: update
  1249.  
  1250. update options
  1251. --------------
  1252.  
  1253.    These standard options are available with `update' (*note Common
  1254. options::., for a complete description of them):
  1255.  
  1256. `-D date'
  1257.      Use the most recent revision no later than DATE.  This option is
  1258.      sticky, and implies `-P'.  See *Note Sticky tags::, for more
  1259.      information on sticky tags/dates.
  1260.  
  1261. `-f'
  1262.      Only useful with the `-D DATE' or `-r TAG' flags.  If no matching
  1263.      revision is found, retrieve the most recent revision (instead of
  1264.      ignoring the file).
  1265.  
  1266. `-k KFLAG'
  1267.      Process RCS keywords according to KFLAG.  See co(1).  This option
  1268.      is sticky; future updates of this file in this working directory
  1269.      will use the same KFLAG.  The `status' command can be viewed to
  1270.      see the sticky options.  *Note status::.
  1271.  
  1272. `-l'
  1273.      Local; run only in current working directory.  *Note Recursive
  1274.      behavior::.
  1275.  
  1276. `-P'
  1277.      Prune empty directories.
  1278.  
  1279. `-p'
  1280.      Pipe files to the standard output.
  1281.  
  1282. `-R'
  1283.      Operate recursively.  This is on by default.  *Note Recursive
  1284.      behavior::.
  1285.  
  1286. `-r tag'
  1287.      Retrieve revision TAG.  This option is sticky, and implies `-P'.
  1288.      See *Note Sticky tags::, for more information on sticky tags/dates.
  1289.  
  1290.    These special options are also available with `update'.
  1291.  
  1292. `-A'
  1293.      Reset any sticky tags, dates, or `-k' options.  See *Note Sticky
  1294.      tags::, for more information on sticky tags/dates.
  1295.  
  1296. `-d'
  1297.      Create any directories that exist in the repository if they're
  1298.      missing from the working directory.  Normally, `update' acts only
  1299.      on directories and files that were already enrolled in your
  1300.      working directory.
  1301.  
  1302.      This is useful for updating directories that were created in the
  1303.      repository since the initial checkout; but it has an unfortunate
  1304.      side effect.  If you deliberately avoided certain directories in
  1305.      the repository when you created your working directory (either
  1306.      through use of a module name or by listing explicitly the files
  1307.      and directories you wanted on the command line), then updating
  1308.      with `-d' will create those directories, which may not be what you
  1309.      want.
  1310.  
  1311. `-I NAME'
  1312.      Ignore files whose names match NAME (in your working directory)
  1313.      during the update.  You can specify `-I' more than once on the
  1314.      command line to specify several files to ignore.  Use `-I !' to
  1315.      avoid ignoring any files at all.  *Note cvsignore::, for other
  1316.      ways to make CVS ignore some files.
  1317.  
  1318. `-WSPEC'
  1319.      Specify file names that should be filtered during update.  You can
  1320.      use this option repeatedly.
  1321.  
  1322.      SPEC can be a file name pattern of the same type that you can
  1323.      specify in the `.cvswrappers' file. *Note Wrappers::.
  1324.  
  1325. `-jREVISION'
  1326.      With two `-j' options, merge changes from the revision specified
  1327.      with the first `-j' option to the revision specified with the
  1328.      second `j' option, into the working directory.
  1329.  
  1330.      With one `-j' option, merge changes from the ancestor revision to
  1331.      the revision specified with the `-j' option, into the working
  1332.      directory.  The ancestor revision is the common ancestor of the
  1333.      revision which the working directory is based on, and the revision
  1334.      specified in the `-j' option.
  1335.  
  1336.      In addition, each -j option can contain an optional date
  1337.      specification which, when used with branches, can limit the chosen
  1338.      revision to one within a specific date.  An optional date is
  1339.      specified by adding a colon (:) to the tag:
  1340.      `-jSYMBOLIC_TAG:DATE_SPECIFIER'.
  1341.  
  1342.      *Note Merging::.
  1343.  
  1344. 
  1345. File: cvs.info,  Node: update output,  Next: update examples,  Prev: update options,  Up: update
  1346.  
  1347. update output
  1348. -------------
  1349.  
  1350.    `update' keeps you informed of its progress by printing a line for
  1351. each file, preceded by one character indicating the status of the file:
  1352.  
  1353. `U FILE'
  1354.      The file was brought up to date with respect to the repository.
  1355.      This is done for any file that exists in the repository but not in
  1356.      your source, and for files that you haven't changed but are not
  1357.      the most recent versions available in the repository.
  1358.  
  1359. `A FILE'
  1360.      The file has been added to your private copy of the sources, and
  1361.      will be added to the source repository when you run `commit' on
  1362.      the file.  This is a reminder to you that the file needs to be
  1363.      committed.
  1364.  
  1365. `R FILE'
  1366.      The file has been removed from your private copy of the sources,
  1367.      and will be removed from the source repository when you run
  1368.      `commit' on the file.  This is a reminder to you that the file
  1369.      needs to be committed.
  1370.  
  1371. `M FILE'
  1372.      The file is modified in  your  working  directory.
  1373.  
  1374.      `M' can indicate one of two states for a file you're working on:
  1375.      either there were no modifications to the same file in the
  1376.      repository, so that your file remains as you last saw it; or there
  1377.      were modifications in the repository as well as in your copy, but
  1378.      they were merged successfully, without conflict, in your working
  1379.      directory.
  1380.  
  1381.      CVS will print some messages if it merges your work, and a backup
  1382.      copy of your working file (as it looked before you ran `update')
  1383.      will be made.  The exact name of that file is printed while
  1384.      `update' runs.
  1385.  
  1386. `C FILE'
  1387.      A conflict was detected while trying to merge your changes to FILE
  1388.      with changes from the source repository.  FILE (the copy in your
  1389.      working directory) is now the output of the rcsmerge(1) command on
  1390.      the two revisions; an unmodified copy of your file is also in your
  1391.      working directory, with the name `.#FILE.REVISION' where REVISION
  1392.      is the RCS revision that your modified file started from.  (Note
  1393.      that some systems automatically purge files that begin with `.#'
  1394.      if they have not been accessed for a few days.  If you intend to
  1395.      keep a copy of your original file, it is a very good idea to rename
  1396.      it.)
  1397.  
  1398. `? FILE'
  1399.      FILE is in your working directory, but does not correspond to
  1400.      anything in the source repository, and is not in the list of files
  1401.      for CVS to ignore (see the description of the `-I' option, and
  1402.      *note cvsignore::.).
  1403.  
  1404.      Note that no warning message like this is printed for spurious
  1405.      directories that CVS encounters.  The directory, and all its
  1406.      contents, are silently ignored.
  1407.  
  1408. 
  1409. File: cvs.info,  Node: update examples,  Prev: update output,  Up: update
  1410.  
  1411. update examples
  1412. ---------------
  1413.  
  1414.    The following line will display all files which are not up-to-date
  1415. without actually change anything in your working directory.  It can be
  1416. used to check what has been going on with the project.
  1417.  
  1418.      $ cvs -n -q update
  1419.  
  1420. 
  1421. File: cvs.info,  Node: Administrative files,  Next: Environment variables,  Prev: Invoking CVS,  Up: Top
  1422.  
  1423. Reference manual for the Administrative files
  1424. *********************************************
  1425.  
  1426.    Inside the repository, in the directory `$CVSROOT/CVSROOT', there
  1427. are a number of supportive files for CVS.  You can use CVS in a limited
  1428. fashion without any of them, but if they are set up properly they can
  1429. help make life easier.
  1430.  
  1431.    The most important of these files is the `modules' file, which
  1432. defines the modules inside the repository.
  1433.  
  1434. * Menu:
  1435.  
  1436. * modules::                     Defining modules
  1437. * Wrappers::                    Treat directories as files
  1438. * commit files::                The commit support files
  1439. * commitinfo::                  Pre-commit checking
  1440. * editinfo::                    Specifying how log messages are created
  1441. * loginfo::                     Where should log messages be sent?
  1442. * rcsinfo::                     Templates for the log messages
  1443. * cvsignore::                   Ignoring files via cvsignore
  1444. * history file::                History information
  1445. * Setting up::                  Setting up the repository
  1446. * Variables::                   Various variables are expanded
  1447.  
  1448.